﻿                 #########################################
                          Banjo - Kazooie Editor
                               By PacoChan
                       http://pacochan.tales-tra.com
                 #########################################


This little program contains some tools to make easier the translation
process of Banjo-Kazooie. Note that this is ONLY compatible with the
european version of the game.



################################ HOW TO USE ###############################

- First, you should put the Banjo-Kazooie rom (the european one) in the
  same folder as the program.

- When you start the program for the first time, it will ask you where is
  the ROM. Once you have selected it, you will be working always with that
  ROM. If you want to select another rom, press the Configure button and
  then Change working ROM.

- All the english texts are already in the "original" folder.
  In the program, at the right, there is a list with all the text files.
  Just double click one of them to load it. Then you will be able to edit
  it with the text box at the bottom of the window.

- When you have translated a file, remember to press "Save". The file will
  be marked in the list. Marked files mean that they are translated.
  All the translated files will be saved to the "translated" folder.

- If there is a glitch and a text file gets corrupt, you can delete it from
  the "translated" folder, so the program will mark it as untranslated and
  you will be able to translate it again.

- When you want to test the translation, just press the Insert into ROM,
  and the program will insert all the translated texts, the font and the
  graphics into the previously selected ROM.

- You can edit the fonts with the Fonts menu. There are two fonts: the
  normal one used in most of the game, and a big one used in some menus.
  To extract one of the fonts to TGA files, press the "Extract font"
  button. You will have to select the file where the font you want to edit
  is stored ("font" folder). It will extract all the characters to a
  sub-folder inside "font" folder. Now you can edit those TGAs.
  
- If you decide to change the resolution of a TGA file, the width MUST be
  even. And don't change the height. Try to avoid making the  fonts files
  bigger, as it could cause problems. If you make a letter bigger, try to
  make another one smaller.

- To reinsert a font, press Insert font, and select which of the font files
  you want to update.

- You can also change the character widths. Since the game uses variable
  width fonts, you'll probably need to edit those widths, because if a
  letter is bigger than the original, it will appear cropped in the game.
  And if the letter is smaller, it will appear with an empty space in game.

- Once the font is edited, you will need to do a table for each edited
  font so the special characters you added are shown in the program.
  
  For example, if you want to add the character "Á" in the normal font,
  you could edit the image file "58.tga". And if you want the character
  "É", you could edit "65.tga". Then, you will have to edit "table.txt"
  like this:
  
  Á=58
  É=65
  
  And that's it. Now you will be able to enter those characters in the
  program and the equivalent ones will appear in the game.
  
  Make sure that the table files is encoded in Unicode, or it will not work
  properly. The already provided file is encoded in Unicode, so you just
  have to edit it. But if there were problems with it, check the encoding
  and change it with some text program.

- There are also some texts that have some codes like "~" and some
  sentences like this: "CODE IS 'ý?BLUEEGGSýl'. ENTER CODE ON SANDCASTLE
  FLOOR IN TREASURE TROVE COVE". In that sentence you can see
  'ý?BLUEEGGSýl'. Do not change these codes. Those are internal variables
  and things like that. For example, the spanish translation would be
  "EL CÓDIGO ES 'ý?BLUEEGGSýl'."
  
- This program already includes some images that can be translated in
  "graphics" folder. You'll need another program to edit those files.
  Common romhacking programs to edit images are n64gfx, Tile Molester,
  Tile Layer Pro. You’ll see tutorials on the internet on how to use them.

- There are more images that can be edited and aren't included with the
  program. Use SubDrag's program called GEDecompressor to uncompress the
  whole ROM and find whatever graphics you want to edit and then put them
  in the graphics folder.
  
- All file names contain an hexadecimal code, like: "217A00.bin". Do not
  change that code because it's needed by the program. If you want to
  rename those files to know what they are, you can rename them to
  something like "217A00 (tombstone).bin". But always having the code at
  the beginning of the name.
  
- You can edit the menus with de "Edit menus" button.

  
  
################################ CHANGELOG ################################

1.4: - Now the program is able to import correctly TGA files with modified
       resolution.
     - Fixed some bugs while inserting and extracting a font.  
1.3: - Added support for the big font that appears in some menus.
     - Character's names in the credits are now editable.
     - Some interface modifications.
     - The Readme.txt file can be seen in the Help menu of the editor.
1.2: - Some compression optimizations.
     - Interface improvements.
     - Now automatically generates all the checksums needed to be able to
       edit the menus without breaking the game.
     - Added a menu editor.
     - The menu language is patched so it doesn't appear after the Press
       Start screen. It's no longer needed as the game it's also patched to
       have only one language. This way there's more free space available
       for your translation.
     - Added some tools to compress and decompress individual files,
       generate the ROM CRCs and generate checksums of those files. I left
       them for testing pursposes.
1.1: - Fixed a crash while reading certain TGA files from the font. Now the
       program should be able to read all TGA variants.
1.0: - Initial release
  
  

And I think that's all. I hope you like my program and contact me if you
don't understand something.